/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.wsinfra.util;

import javax.xml.namespace.QName;

import org.apache.xmlbeans.XmlCursor;
import org.apache.xmlbeans.XmlObject;

import cgl.narada.wsinfra.schemas.soap.BodyType;
import cgl.narada.wsinfra.schemas.soap.EnvelopeDocument;
import cgl.narada.wsinfra.schemas.soap.EnvelopeType;
import cgl.narada.wsinfra.schemas.soap.HeaderType;

/** This is a utility class which facilitates the addition of elements to
    Header or Body of the SOAP envelope.

    @author Shrideep Pallickara
    $Date: 2005/07/29 22:41:29 $
    $Revision: 1.7 $
*/


public class SoapMessageAlteration {
  private static final
  SoapMessageAlteration instance = new SoapMessageAlteration();
  private XmlContentTransfer xmlContentTransfer;
  private QNameLocator qNameLocator;
  private static final QName actorQName = 
  new QName("http://schemas.xmlsoap.org/soap/envelope/", "actor");

  private String moduleName = "SoapMessageAlteration: ";

  private SoapMessageAlteration() {
    xmlContentTransfer = XmlContentTransfer.getInstance();
    qNameLocator = QNameLocator.getInstance();
  }


  public static SoapMessageAlteration getInstance() {
    return instance;
  }

  /** Adds the specified XmlObject to the Body of the SOAP message */
  public void addToSoapBody(EnvelopeDocument envelopeDocument,
			    XmlObject xmlObject) {
    if (envelopeDocument == null || xmlObject == null) {
      return;
    }
    EnvelopeType envelope = envelopeDocument.getEnvelope();
    BodyType body = envelope.getBody();
    xmlContentTransfer.copyFromSourceToDestination(xmlObject, body);
  }


  /** Adds the specified XmlObject to the Header of the SOAP message */
  public void addToSoapHeader(EnvelopeDocument envelopeDocument,
			      XmlObject xmlObject) {
    if (envelopeDocument == null || xmlObject == null) {
      return;
    }
    EnvelopeType envelope = envelopeDocument.getEnvelope();
    HeaderType header = envelope.getHeader();
    xmlContentTransfer.copyFromSourceToDestination(xmlObject, header);
  }


  /** Adds the specified XmlObject to the Header of the SOAP message */
  public void addToSoapHeaderAsLastChild(EnvelopeDocument envelopeDocument,
					 XmlObject xmlObject) {
    if (envelopeDocument == null || xmlObject == null) {
      return;
    }
    EnvelopeType envelope = envelopeDocument.getEnvelope();
    HeaderType header = envelope.getHeader();
    xmlContentTransfer.copyFromSourceToDestinationAsLastChild(xmlObject, 
							      header);
  }

  
  /** Adds a QName and the corresponding value to a SOAP Header. This method
      returns <i>true</i>, if the operation was successful and <i>false</i> 
      otherwise.*/
  public boolean addToSoapHeader(EnvelopeDocument envelopeDocument,
				 QName qName, String value) {
    if (envelopeDocument == null || qName == null || value == null) {
      return false;
    }
    
    EnvelopeType envelopeType = envelopeDocument.getEnvelope();
    if (envelopeType == null) {
      System.out.println(moduleName + "The EnvelopeType is NULL.");
      return false;
    }
    
    if (!envelopeType.isSetHeader()) {
      System.out.println(moduleName + "This Envelope DOES NOT have a header.");
      return false;
    }
    
    XmlCursor headerCursor = envelopeType.getHeader().newCursor();
    headerCursor.toNextToken();
    headerCursor.insertElementWithText(qName, value);
    headerCursor.dispose();

    return true;
  }



  /** Adds a QName with a specific value along with an attribute and attribute
      value to a soap header. This method
      returns <i>true</i>, if the operation was successful and <i>false</i> 
      otherwise.*/
  public boolean addToSoapHeader(EnvelopeDocument envelopeDocument,
				 QName qName, String value,
				 QName attributeQName, String attributeValue) {
    if (envelopeDocument == null || qName == null || value == null) {
      return false;
    }
    
    EnvelopeType envelopeType = envelopeDocument.getEnvelope();
    if (envelopeType == null) {
      System.out.println(moduleName + "The EnvelopeType is NULL.");
      return false;
    }
    
    if (!envelopeType.isSetHeader()) {
      System.out.println(moduleName + "This Envelope DOES NOT have a header.");
      return false;
    }
    
    XmlCursor headerCursor = envelopeType.getHeader().newCursor();
    headerCursor.push();

    headerCursor.toNextToken();
    headerCursor.insertElementWithText(qName, value);

    headerCursor.pop();
    headerCursor.toNextToken();
    headerCursor.toNextToken();
    headerCursor.insertAttributeWithValue(attributeQName, attributeValue);
    
    headerCursor.dispose();

    return true;
  }



  /** Adds a QName with a specific value along with the SOAP actor attribute
      based on the specified attribute value to the SOAP Header. This method
      returns <i>true</i>, if the operation was successful and <i>false</i> 
      otherwise.*/
  public boolean 
  addToSoapHeaderWithActorAttribute(EnvelopeDocument envelopeDocument,
				    QName qName, String value,
				    String actorAttributeValue) {
    return addToSoapHeader(envelopeDocument, qName, value, 
			   actorQName, actorAttributeValue);
  }



  


  /** Removes a QName and corresponding text value encapsulated by it from
      the specified document. This method returns  <i>true</i>, if the 
      operation was successful and <i>false</i> otherwise.*/
  public boolean removeFromSoapHeader(EnvelopeDocument envelopeDocument,
				      QName qName) {
    if (envelopeDocument == null || qName == null ) {
      return false;
    }

     EnvelopeType envelopeType = envelopeDocument.getEnvelope();
    if (envelopeType == null) {
      System.out.println(moduleName + "The EnvelopeType is NULL.");
      return false;
    }
    
    if (!envelopeType.isSetHeader()) {
      System.out.println(moduleName + "This Envelope DOES NOT have a header.");
      return false;
    }
    
    XmlCursor headerCursor = envelopeType.getHeader().newCursor();
    boolean found = qNameLocator.locateQName(headerCursor, qName);
    
    if (!found) {
      System.out.println(moduleName + "Document DOES NOT contain QName " +
			 "submitted for removal");
      return false;
    }
    
    headerCursor.removeXml();
    headerCursor.dispose();
    return true;
  }
}
